

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Button (lv_btn) &mdash; LVGL  documentation</title>
  

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/fontawesome.min.css" type="text/css" />

  
  
    <link rel="shortcut icon" href="../_static/favicon.png"/>
  
  
  

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Button matrix (lv_btnmatrix)" href="btnmatrix.html" />
    <link rel="prev" title="Bar (lv_bar)" href="bar.html" />
 
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-78811084-3"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

	gtag('config', 'UA-78811084-3', { 'anonymize_ip': true });
</script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo_lvgl.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
              <div class="version">
                v7.11.0-dev
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#key-features">Key features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#repository-layout">Repository layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#release-policy">Release policy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#branches">Branches</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#release-cycle">Release cycle</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#tags">Tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#changelog">Changelog</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#side-projects">Side projects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#version-support">Version support</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html#faq">FAQ</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#where-can-i-ask-questions">Where can I ask questions?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#is-my-mcu-hardware-supported">Is my MCU/hardware supported?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#is-my-display-supported">Is my display supported?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#nothing-happens-my-display-driver-is-not-called-what-have-i-missed">Nothing happens, my display driver is not called. What have I missed?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-the-display-driver-is-called-only-once-only-the-upper-part-of-the-display-is-refreshed">Why the display driver is called only once? Only the upper part of the display is refreshed.</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-i-see-only-garbage-on-the-screen">Why I see only garbage on the screen?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#why-i-see-non-sense-colors-on-the-screen">Why I see non-sense colors on the screen?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-speed-up-my-ui">How to speed up my UI?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-reduce-flash-rom-usage">How to reduce flash/ROM usage?</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-reduce-the-ram-usage">How to reduce the RAM usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="../intro/index.html#how-to-work-with-an-operating-system">How to work with an operating system?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../get-started/index.html">Get started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../get-started/quick-overview.html">Quick overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#get-started-in-a-simulator">Get started in a simulator</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#add-lvgl-into-your-project">Add LVGL into your project</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#learn-the-basics">Learn the basics</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#widgets">Widgets</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#events">Events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#parts">Parts</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#styles">Styles</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#themes">Themes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#button-with-label">Button with label</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#styling-buttons">Styling buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#slider-and-alignment">Slider and alignment</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#micropython">Micropython</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/pc-simulator.html">Simulator on PC</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#select-an-ide">Select an IDE</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#set-up-eclipse-cdt">Set-up Eclipse CDT</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-eclipse-cdt">Install Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-sdl-2">Install SDL 2</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#pre-configured-project">Pre-configured project</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#add-the-pre-configured-project-to-eclipse-cdt">Add the pre-configured project to Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#compile-and-run">Compile and Run</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/stm32.html">STM32</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/nxp.html">NXP</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nxp.html#creating-new-project-with-lvgl">Creating new project with LVGL</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nxp.html#adding-hw-acceleration-for-nxp-imx-rt-platforms-using-pxp-pixel-pipeline-engine-for-existing-projects">Adding HW acceleration for NXP iMX RT platforms using PXP (PiXel Pipeline) engine for existing projects</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#features-supported">Features supported:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#basic-configuration">Basic configuration:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#basic-initialization">Basic initialization:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#project-setup">Project setup:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nxp.html#advanced-configuration">Advanced configuration:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/espressif.html">Espressif (ESP32)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#get-the-lvgl-demo-project-for-esp32">Get the LVGL demo project for ESP32</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#use-lvgl-in-your-esp32-project">Use LVGL in your ESP32 project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#get-lvgl">Get LVGL</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/espressif.html#use-lvgl-esp32-drivers-in-your-project">Use lvgl_esp32_drivers in your project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/espressif.html#support-for-esp32-s2">Support for ESP32-S2</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/arduino.html">Arduino</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#get-the-lvgl-ardunio-library">Get the LVGL Ardunio library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#set-up-drivers">Set up drivers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#configure-lvgl">Configure LVGL</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#configure-the-examples">Configure the examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#initialize-lvgl-and-run-an-example">Initialize LVGL and run an example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/arduino.html#debugging-and-logging">Debugging and logging</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/micropython.html">Micropython</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#what-is-micropython">What is Micropython?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#highlights-of-micropython">Highlights of Micropython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#why-micropython-lvgl">Why Micropython + LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#here-are-some-advantages-of-using-lvgl-in-micropython">Here are some advantages of using LVGL in Micropython:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#micropython-lvgl-could-be-used-for">Micropython + LVGL could be used for:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#so-what-does-it-look-like">So what does it look like?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#a-simple-example">A simple example</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#how-can-i-use-it">How can I use it?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#online-simulator">Online Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#pc-simulator">PC Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#embedded-platform">Embedded platform</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#where-can-i-find-more-information">Where can I find more information?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/nuttx.html">NuttX RTOS</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#what-is-nuttx">What is NuttX?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#highlights-of-nuttx">Highlights of NuttX</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#why-nuttx-lvgl">Why NuttX + LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#here-are-some-advantages-of-using-lvgl-in-nuttx">Here are some advantages of using LVGL in NuttX</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#nuttx-lvgl-could-be-used-for">NuttX + LVGL could be used for</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#how-to-get-started-with-nuttx-and-lvgl">How to get started with NuttX and LVGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#first-you-need-to-install-the-pre-requisite-on-your-system">First you need to install the pre-requisite on your system</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#now-let-s-to-create-a-workspace-to-save-our-files">Now let's to create a workspace to save our files</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#clone-the-nuttx-and-apps-repositories">Clone the NuttX and Apps repositories:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#configure-nuttx-to-use-the-stm32f429i-disco-board-and-the-lvgl-demo">Configure NuttX to use the stm32f429i-disco board and the LVGL Demo</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/nuttx.html#flashing-the-firmware-in-the-board-using-openocd">Flashing the firmware in the board using OpenOCD:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/nuttx.html#where-can-i-find-more-information">Where can I find more information?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../porting/index.html">Porting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../porting/sys.html">System overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/project.html">Set-up a project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#get-the-library">Get the library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#configuration-file">Configuration file</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#initialization">Initialization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/display.html">Display interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-buffer">Display buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-driver">Display driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#rotation">Rotation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/indev.html">Input device interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#types-of-input-devices">Types of input devices</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#touchpad-mouse-or-any-pointer">Touchpad, mouse or any pointer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#keypad-or-keyboard">Keypad or keyboard</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#encoder">Encoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#button">Button</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#other-features">Other features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/tick.html">Tick interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/tick.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/task-handler.html">Task Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/sleep.html">Sleep management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/os.html">Operating system and interrupts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#tasks-and-threads">Tasks and threads</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#interrupts">Interrupts</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/log.html">Logging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#log-level">Log level</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#logging-with-printf">Logging with printf</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#custom-log-function">Custom log function</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#add-logs">Add logs</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/object.html">Objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#attributes">Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#basic-attributes">Basic attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#specific-attributes">Specific attributes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#working-mechanisms">Working mechanisms</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#parent-child-structure">Parent-child structure</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#moving-together">Moving together</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#visibility-only-on-the-parent">Visibility only on the parent</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#create-delete-objects">Create - delete objects</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#screens">Screens</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#create-screens">Create screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#get-the-active-screen">Get the active screen</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#load-screens">Load screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#handling-multiple-displays">Handling multiple displays</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#parts">Parts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#states">States</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/layer.html">Layers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#order-of-creation">Order of creation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#bring-to-the-foreground">Bring to the foreground</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#top-and-sys-layers">Top and sys layers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/event.html">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#event-types">Event types</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#generic-events">Generic events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#special-events">Special events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#custom-data">Custom data</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#send-events-manually">Send events manually</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#arbitrary-events">Arbitrary events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#refresh-event">Refresh event</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/style.html">Styles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#states">States</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#cascading-styles">Cascading styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#inheritance">Inheritance</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#parts">Parts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#initialize-styles-and-set-get-properties">Initialize styles and set/get properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#managing-style-list">Managing style list</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#local-styles">Local styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#transitions">Transitions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#properties">Properties</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#mixed-properties">Mixed properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#padding-and-margin-properties">Padding and margin properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#background-properties">Background properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#border-properties">Border properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#outline-properties">Outline properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#shadow-properties">Shadow properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#pattern-properties">Pattern properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#value-properties">Value properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#text-properties">Text properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#line-properties">Line properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#image-properties">Image properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#transition-properties">Transition properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#scale-properties">Scale properties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#themes">Themes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#extending-themes">Extending themes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#styling-a-button">Styling a button</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/indev.html">Input devices</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#pointers">Pointers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#keypad-and-encoder">Keypad and encoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#styling">Styling</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#input-device">Input device</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#id1">Groups</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/display.html">Displays</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#multiple-display-support">Multiple display support</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#using-only-one-display">Using only one display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#mirror-display">Mirror display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#split-image">Split image</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#screens">Screens</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#transparent-screens">Transparent screens</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#features-of-displays">Features of displays</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#inactivity">Inactivity</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#background">Background</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#colors">Colors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#convert-color">Convert color</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#swap-16-colors">Swap 16 colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#create-and-mix-colors">Create and mix colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#opacity">Opacity</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#built-in-colors">Built-in colors</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#display">Display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#id1">Colors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/font.html">Fonts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#unicode-support">Unicode support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#built-in-fonts">Built-in fonts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#normal-fonts">Normal fonts</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#special-fonts">Special fonts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#special-features">Special features</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#bidirectional-support">Bidirectional support</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#arabic-and-persian-support">Arabic and Persian support</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#subpixel-rendering">Subpixel rendering</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#compress-fonts">Compress fonts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-font">Add new font</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-symbols">Add new symbols</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#load-font-in-run-time">Load font in run-time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-a-new-font-engine">Add a new font engine</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/image.html">Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#store-images">Store images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#variables">Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#files">Files</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#color-formats">Color formats</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#add-and-use-images">Add and use images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#online-converter">Online converter</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-create-an-image">Manually create an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#use-images">Use images</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-decoder">Image decoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#custom-image-formats">Custom image formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#register-an-image-decoder">Register an image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-use-an-image-decoder">Manually use an image decoder</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-caching">Image caching</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#cache-size">Cache size</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#value-of-images">Value of images</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#memory-usage">Memory usage</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#clean-the-cache">Clean the cache</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#id1">Image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-cache">Image cache</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-buffer">Image buffer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-draw">Image draw</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/file-system.html">File system</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#add-a-driver">Add a driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#usage-example">Usage example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#use-drivers-for-images">Use drivers for images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/animation.html">Animations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#create-an-animation">Create an animation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#animation-path">Animation path</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#speed-vs-time">Speed vs time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#delete-animations">Delete animations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/animation.html#input-device">Input device</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/task.html">Tasks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#create-a-task">Create a task</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#ready-and-reset">Ready and Reset</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#set-parameters">Set parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#one-shot-tasks">One-shot tasks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#measure-idle-time">Measure idle time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#asynchronous-calls">Asynchronous calls</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/drawing.html">Drawing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#buffering-types">Buffering types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#mechanism-of-screen-refreshing">Mechanism of screen refreshing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#masking">Masking</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/drawing.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/drawing.html#micropython">MicroPython</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Widgets</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="obj.html">Base object (lv_obj)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obj.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#coordinates">Coordinates</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#parents-and-children">Parents and children</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#screens">Screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#layers">Layers</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#events">Events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#parts">Parts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#style">Style</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#attributes">Attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#protect">Protect</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#extended-click-area">Extended click area</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#id1">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="arc.html">Arc (lv_arc)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arc.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#angles">Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#rotation">Rotation</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#range-and-values">Range and values</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#type">Type</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bar.html">Bar (lv_bar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bar.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#value-and-range">Value and range</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#modes">Modes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Button (lv_btn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="#checkable">Checkable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#layout-and-fit">Layout and Fit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="btnmatrix.html">Button matrix (lv_btnmatrix)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#button-s-text">Button's text</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#one-check">One check</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#aligning-the-button-s-text">Aligning the button's text</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnmatrix.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnmatrix.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar (lv_calendar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#id1">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#current-date">Current date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#shown-date">Shown date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#highlighted-days">Highlighted days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-days">Name of the days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-months">Name of the months</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="canvas.html">Canvas (lv_canvas)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#buffer">Buffer</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#palette">Palette</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#drawing">Drawing</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#transformations">Transformations</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#blur">Blur</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="checkbox.html">Checkbox (lv_cb)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#text">Text</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#check-uncheck">Check/Uncheck</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#disabled">Disabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#get-set-checkbox-state">Get/Set Checkbox State</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="checkbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="checkbox.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="chart.html">Chart (lv_chart)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="chart.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#data-series">Data series</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#series-type">Series' type</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#modify-the-data">Modify the data</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#override-default-start-point-for-series">Override default start point for series</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#set-an-external-data-source">Set an external data source</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#get-current-chart-information">Get current chart information</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#update-modes">Update modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#number-of-points">Number of points</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#vertical-range">Vertical range</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#division-lines">Division lines</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#tick-marks-and-labels">Tick marks and labels</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#cursor">Cursor</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cont.html">Container (lv_cont)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cont.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#autofit">Autofit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpicker.html">Color picker (lv_cpicker)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#type">Type</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#set-color">Set color</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#color-mode">Color mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#knob-color">Knob color</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dropdown.html">Drop-down list (lv_dropdown)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#id1">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#direction">Direction</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#symbol">Symbol</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#maximum-height">Maximum height</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#show-selected">Show selected</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#manually-open-close">Manually open/close</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="dropdown.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dropdown.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gauge.html">Gauge (lv_gauge)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#set-value-and-needles">Set value and needles</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#scale">Scale</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#range">Range</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#needle-image">Needle image</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#critical-value">Critical value</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="img.html">Image (lv_img)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="img.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#image-source">Image source</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#label-as-an-image">Label as an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#transparency">Transparency</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#palette-and-alpha-index">Palette and Alpha index</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#mosaic">Mosaic</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#offset">Offset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#transformations">Transformations</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#rotate">Rotate</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="imgbtn.html">Image button (lv_imgbtn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#image-sources">Image sources</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#button-features">Button features</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keyboard.html">Keyboard (lv_keyboard)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#modes">Modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#assign-text-area">Assign Text area</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#new-keymap">New Keymap</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="keyboard.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="keyboard.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="label.html">Label (lv_label)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="label.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#line-break">Line break</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#long-modes">Long modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-recolor">Text recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#symbols">Symbols</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="led.html">LED (lv_led)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="led.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#brightness">Brightness</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#toggle">Toggle</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="line.html">Line (lv_line)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="line.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#set-points">Set points</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#invert-y">Invert y</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="list.html">List (lv_list)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="list.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#delete-buttons">Delete buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="linemeter.html">Line meter (lv_lmeter)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#set-value">Set value</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#range-and-angles">Range and Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#angle-offset">Angle offset</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#mirror">Mirror</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="linemeter.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="linemeter.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="msgbox.html">Message box (lv_msgbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#auto-close">Auto-close</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="msgbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="msgbox.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="objmask.html">Object mask (lv_objmask)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="objmask.html#adding-mask">Adding mask</a></li>
<li class="toctree-l4"><a class="reference internal" href="objmask.html#update-mask">Update mask</a></li>
<li class="toctree-l4"><a class="reference internal" href="objmask.html#remove-mask">Remove mask</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="objmask.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="objmask.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="objmask.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="page.html">Page (lv_page)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="page.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#glue-object">Glue object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#focus-object">Focus object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#clean-the-page">Clean the page</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollable-api">Scrollable API</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="roller.html">Roller (lv_roller)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="roller.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#align-the-options">Align the options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#visible-rows">Visible rows</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="slider.html">Slider (lv_slider)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="slider.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#value-and-range">Value and range</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#symmetrical-and-range">Symmetrical and Range</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#knob-only-mode">Knob-only mode</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spinbox.html">Spinbox (lv_spinbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#set-format">Set format</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#value-and-ranges">Value and ranges</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#api">API</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#id1">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spinner.html">Spinner (lv_spinner)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#arc-length">Arc length</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spinning-speed">Spinning speed</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spin-types">Spin types</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#spin-direction">Spin direction</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinner.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinner.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="switch.html">Switch (lv_switch)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="switch.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="switch.html#change-state">Change state</a></li>
<li class="toctree-l4"><a class="reference internal" href="switch.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="switch.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="switch.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="switch.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="table.html">Table (lv_table)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="table.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#rows-and-columns">Rows and Columns</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#width-and-height">Width and Height</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#set-cell-value">Set cell value</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#align">Align</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#cell-type">Cell type</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#merge-cells">Merge cells</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#crop-text">Crop text</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#scroll">Scroll</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tabview.html">Tabview (lv_tabview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#adding-tab">Adding tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#change-tab">Change tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#change-tab-s-name">Change tab's name</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#tab-button-s-position">Tab button's position</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="textarea.html">Text area (lv_textarea)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#add-text">Add text</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#placeholder">Placeholder</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#delete-character">Delete character</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#move-the-cursor">Move the cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#hide-the-cursor">Hide the cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#cursor-blink-time">Cursor blink time</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#one-line-mode">One line mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#password-mode">Password mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#accepted-characters">Accepted characters</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#max-text-length">Max text length</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#select-text">Select text</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="textarea.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="textarea.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileview.html">Tile view (lv_tileview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#parts-and-styles">Parts and Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#usage">Usage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#valid-positions">Valid positions</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#set-tile">Set tile</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#add-element">Add element</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="win.html">Window (lv_win)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="win.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#parts-and-styles">Parts and Styles</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#title">Title</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#manual-scroll-and-focus">Manual scroll and focus</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#layout">Layout</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#api">API</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#pull-request">Pull request</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#from-github">From GitHub</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#from-command-line">From command line</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#developer-certification-of-origin-dco">Developer Certification of Origin (DCO)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#accepted-licenses-and-copyright-notices">Accepted licenses and copyright notices</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#your-own-work">Your own work</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-code-from-online-source">Use code from online source</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-mit-licensed-code">Use MIT licensed code</a></li>
<li class="toctree-l4"><a class="reference internal" href="../contributing/index.html#use-gpl-licensed-code">Use GPL licensed code</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-get-started-with-lvgl">When you get started with LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#give-lvgl-a-star">Give LVGL a Star</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#tell-what-you-have-achieved">Tell what you have achieved</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#write-examples">Write examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#improve-the-docs">Improve the docs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#translate-the-docs">Translate the docs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#write-a-blog-post">Write a blog post</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-already-use-lvgl">When you already use LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#give-feedback">Give feedback</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#report-bugs">Report bugs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#send-fixes">Send fixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#join-the-conversations-in-the-forum">Join the conversations in the Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#add-features">Add features</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/index.html#when-you-are-confident-with-lvgl">When you are confident with LVGL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#become-a-maintainer">Become a maintainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/index.html#move-your-project-repository-under-lvgl-organization">Move your project repository under LVGL organization</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">LVGL</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
        
          <li><a href="index.html">Widgets</a> &raquo;</li>
        
      <li>Button (lv_btn)</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            
              <!-- User defined GitHub URL -->
              <a href="https://github.com/lvgl/docs/blob/latest/widgets/btn.md" class="fa fa-github"> Edit on GitHub</a>
            
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="button-lv-btn">
<h1>Button (lv_btn)<a class="headerlink" href="#button-lv-btn" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>Buttons are simple rectangle-like objects. They are derived from <a class="reference internal" href="cont.html"><span class="doc">Containers</span></a> so <a class="reference external" href="/widgets/cont#layout">layout</a> and <a class="reference external" href="/widgets/cont#fit">fit</a> are also available.
Besides, it can be enabled to automatically go to checked state on click.</p>
</div>
<div class="section" id="parts-and-styles">
<h2>Parts and Styles<a class="headerlink" href="#parts-and-styles" title="Permalink to this headline">¶</a></h2>
<p>The buttons has only a main style called <code class="docutils literal notranslate"><span class="pre">LV_BTN_PART_MAIN</span></code> and it can use all the properties from the following groups:</p>
<ul class="simple">
<li><p>background</p></li>
<li><p>border</p></li>
<li><p>outline</p></li>
<li><p>shadow</p></li>
<li><p>value</p></li>
<li><p>pattern</p></li>
<li><p>transitions</p></li>
</ul>
<p>It also uses the <em>padding</em> properties when <em>layout</em> or <em>fit</em> is enabled.</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="section" id="states">
<h3>States<a class="headerlink" href="#states" title="Permalink to this headline">¶</a></h3>
<p>To make buttons usage simpler the button's state can be get with <code class="docutils literal notranslate"><span class="pre">lv_btn_get_state(btn)</span></code>. It returns one of the following values:</p>
<ul class="simple">
<li><p><strong>LV_BTN_STATE_RELEASED</strong></p></li>
<li><p><strong>LV_BTN_STATE_PRESSED</strong></p></li>
<li><p><strong>LV_BTN_STATE_CHECKED_RELEASED</strong></p></li>
<li><p><strong>LV_BTN_STATE_CHECKED_PRESSED</strong></p></li>
<li><p><strong>LV_BTN_STATE_DISABLED</strong></p></li>
<li><p><strong>LV_BTN_STATE_CHECKED_DISABLED</strong></p></li>
</ul>
<p>With <code class="docutils literal notranslate"><span class="pre">lv_btn_set_state(btn,</span> <span class="pre">LV_BTN_STATE_...)</span></code> the buttons state can be changed manually.</p>
<p>If a more precise description of the state is required (e.g. focused) the general <code class="docutils literal notranslate"><span class="pre">lv_obj_get_state(btn)</span></code> can be used.</p>
</div>
<div class="section" id="checkable">
<h3>Checkable<a class="headerlink" href="#checkable" title="Permalink to this headline">¶</a></h3>
<p>You can configure the buttons as <em>toggle button</em> with <code class="docutils literal notranslate"><span class="pre">lv_btn_set_checkable(btn,</span> <span class="pre">true)</span></code>. In this case, on click, the button goes to <code class="docutils literal notranslate"><span class="pre">LV_STATE_CHECKED</span></code> state automatically, or back when clicked again.</p>
</div>
<div class="section" id="layout-and-fit">
<h3>Layout and Fit<a class="headerlink" href="#layout-and-fit" title="Permalink to this headline">¶</a></h3>
<p>Similarly to <a class="reference internal" href="cont.html"><span class="doc">Containers</span></a>, buttons also have layout and fit attributes.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_layout(btn,</span> <span class="pre">LV_LAYOUT_...)</span> </code>set a layout. The default is <code class="docutils literal notranslate"><span class="pre">LV_LAYOUT_CENTER</span></code>.
So, if you add a label, then it will be automatically aligned to the middle and can't be moved with <code class="docutils literal notranslate"><span class="pre">lv_obj_set_pos()</span></code>.
You can disable the layout with <code class="docutils literal notranslate"><span class="pre">lv_btn_set_layout(btn,</span> <span class="pre">LV_LAYOUT_OFF)</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_fit/fit2/fit4(btn,</span> <span class="pre">LV_FIT_..)</span></code> enables to set the button width and/or height automatically according to the children, parent, and fit type.</p></li>
</ul>
</div>
</div>
<div class="section" id="events">
<h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2>
<p>Besides the <a class="reference external" href="../overview/event.html#generic-events">Generic events</a> the following <a class="reference external" href="../overview/event.html#special-events">Special events</a> are sent by the buttons:</p>
<ul class="simple">
<li><p><strong>LV_EVENT_VALUE_CHANGED</strong> - sent when the button is toggled.</p></li>
</ul>
<p>Learn more about <a class="reference internal" href="../overview/event.html"><span class="doc">Events</span></a>.</p>
</div>
<div class="section" id="keys">
<h2>Keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h2>
<p>The following <em>Keys</em> are processed by the Buttons:</p>
<ul class="simple">
<li><p><strong>LV_KEY_RIGHT/UP</strong> - Go to toggled state if toggling is enabled.</p></li>
<li><p><strong>LV_KEY_LEFT/DOWN</strong> - Go to non-toggled state if toggling is enabled.</p></li>
</ul>
<p>Note that, the state of <code class="docutils literal notranslate"><span class="pre">LV_KEY_ENTER</span></code> is translated to <code class="docutils literal notranslate"><span class="pre">LV_EVENT_PRESSED/PRESSING/RELEASED</span></code> etc.</p>
<p>Learn more about <a class="reference internal" href="../overview/indev.html"><span class="doc">Keys</span></a>.</p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="section" id="c">
<h3>C<a class="headerlink" href="#c" title="Permalink to this headline">¶</a></h3>
<div class="section" id="simple-buttons">
<h4>Simple Buttons<a class="headerlink" href="#simple-buttons" title="Permalink to this headline">¶</a></h4>
<iframe class='lv-example' src='../_static/built_lv_examples/lv_ex_btn_1/?w=320&h=240'></iframe><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">&quot;../../../lv_examples.h&quot;</span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf">&lt;stdio.h&gt;</span><span class="cp"></span>
<span class="cp">#if LV_USE_BTN</span>

<span class="k">static</span> <span class="kt">void</span> <span class="n">event_handler</span><span class="p">(</span><span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">obj</span><span class="p">,</span> <span class="n">lv_event_t</span> <span class="n">event</span><span class="p">)</span>
<span class="p">{</span>
    <span class="k">if</span><span class="p">(</span><span class="n">event</span> <span class="o">==</span> <span class="n">LV_EVENT_CLICKED</span><span class="p">)</span> <span class="p">{</span>
        <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Clicked</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
    <span class="p">}</span>
    <span class="k">else</span> <span class="k">if</span><span class="p">(</span><span class="n">event</span> <span class="o">==</span> <span class="n">LV_EVENT_VALUE_CHANGED</span><span class="p">)</span> <span class="p">{</span>
        <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Toggled</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
    <span class="p">}</span>
<span class="p">}</span>

<span class="kt">void</span> <span class="n">lv_ex_btn_1</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">label</span><span class="p">;</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn1</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_event_cb</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="n">event_handler</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">-40</span><span class="p">);</span>

    <span class="n">label</span> <span class="o">=</span> <span class="n">lv_label_create</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_label_set_text</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="s">&quot;Button&quot;</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn2</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_event_cb</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">event_handler</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">40</span><span class="p">);</span>
    <span class="n">lv_btn_set_checkable</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">true</span><span class="p">);</span>
    <span class="n">lv_btn_toggle</span><span class="p">(</span><span class="n">btn2</span><span class="p">);</span>
    <span class="n">lv_btn_set_fit2</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">LV_FIT_NONE</span><span class="p">,</span> <span class="n">LV_FIT_TIGHT</span><span class="p">);</span>

    <span class="n">label</span> <span class="o">=</span> <span class="n">lv_label_create</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_label_set_text</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="s">&quot;Toggled&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="cp">#endif</span>
</pre></div>
</div>
</div>
<iframe class='lv-example' src='../_static/built_lv_examples/lv_ex_btn_2/?w=320&h=240'></iframe><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">&quot;../../../lv_examples.h&quot;</span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf">&lt;stdio.h&gt;</span><span class="cp"></span>
<span class="cp">#if LV_USE_BTN</span>

<span class="cm">/**</span>
<span class="cm"> * Advanced button transition examples</span>
<span class="cm"> */</span>
<span class="kt">void</span> <span class="nf">lv_ex_btn_2</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
    <span class="k">static</span> <span class="n">lv_anim_path_t</span> <span class="n">path_overshoot</span><span class="p">;</span>
    <span class="n">lv_anim_path_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_overshoot</span><span class="p">);</span>
    <span class="n">lv_anim_path_set_cb</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_overshoot</span><span class="p">,</span> <span class="n">lv_anim_path_overshoot</span><span class="p">);</span>

    <span class="k">static</span> <span class="n">lv_anim_path_t</span> <span class="n">path_ease_out</span><span class="p">;</span>
    <span class="n">lv_anim_path_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_ease_out</span><span class="p">);</span>
    <span class="n">lv_anim_path_set_cb</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_ease_out</span><span class="p">,</span> <span class="n">lv_anim_path_ease_out</span><span class="p">);</span>

    <span class="k">static</span> <span class="n">lv_anim_path_t</span> <span class="n">path_ease_in_out</span><span class="p">;</span>
    <span class="n">lv_anim_path_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_ease_in_out</span><span class="p">);</span>
    <span class="n">lv_anim_path_set_cb</span><span class="p">(</span><span class="o">&amp;</span><span class="n">path_ease_in_out</span><span class="p">,</span> <span class="n">lv_anim_path_ease_in_out</span><span class="p">);</span>

    <span class="cm">/*Gum-like button*/</span>
    <span class="k">static</span> <span class="n">lv_style_t</span> <span class="n">style_gum</span><span class="p">;</span>
    <span class="n">lv_style_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">10</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_height</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">-10</span><span class="p">);</span>
    <span class="n">lv_style_set_value_letter_space</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">5</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_path</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">path_overshoot</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_path</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">path_ease_in_out</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_time</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">250</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_delay</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">100</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_1</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_TRANSFORM_WIDTH</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_2</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_TRANSFORM_HEIGHT</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_3</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_gum</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_VALUE_LETTER_SPACE</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn1</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">-80</span><span class="p">);</span>
    <span class="n">lv_obj_add_style</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">style_gum</span><span class="p">);</span>

    <span class="cm">/*Instead of creating a label add a values string*/</span>
    <span class="n">lv_obj_set_style_local_value_str</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="s">&quot;Gum&quot;</span><span class="p">);</span>

    <span class="cm">/*Halo on press*/</span>
    <span class="k">static</span> <span class="n">lv_style_t</span> <span class="n">style_halo</span><span class="p">;</span>
    <span class="n">lv_style_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_time</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">400</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_time</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_delay</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">200</span><span class="p">);</span>
    <span class="n">lv_style_set_outline_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_outline_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
    <span class="n">lv_style_set_outline_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_OPA_COVER</span><span class="p">);</span>
    <span class="n">lv_style_set_outline_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_FOCUSED</span><span class="p">,</span> <span class="n">LV_OPA_COVER</span><span class="p">);</span>   <span class="cm">/*Just to be sure, the theme might use it*/</span>
    <span class="n">lv_style_set_outline_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="n">LV_OPA_TRANSP</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_1</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_OUTLINE_OPA</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_2</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_halo</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_OUTLINE_WIDTH</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn2</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_obj_add_style</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">style_halo</span><span class="p">);</span>
    <span class="n">lv_obj_set_style_local_value_str</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="s">&quot;Halo&quot;</span><span class="p">);</span>

    <span class="cm">/*Ripple on press*/</span>
    <span class="k">static</span> <span class="n">lv_style_t</span> <span class="n">style_ripple</span><span class="p">;</span>
    <span class="n">lv_style_init</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_time</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">300</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_time</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_delay</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">300</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_bg_opa</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="n">LV_OPA_80</span><span class="p">);</span>
    <span class="n">lv_style_set_border_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_outline_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">-20</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_height</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="mi">-20</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_width</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
    <span class="n">lv_style_set_transform_height</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_PRESSED</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>

    <span class="n">lv_style_set_transition_path</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">path_ease_out</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_1</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_BG_OPA</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_2</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_TRANSFORM_WIDTH</span><span class="p">);</span>
    <span class="n">lv_style_set_transition_prop_3</span><span class="p">(</span><span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="n">LV_STYLE_TRANSFORM_HEIGHT</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn3</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn3</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">80</span><span class="p">);</span>
    <span class="n">lv_obj_add_style</span><span class="p">(</span><span class="n">btn3</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">style_ripple</span><span class="p">);</span>
    <span class="n">lv_obj_set_style_local_value_str</span><span class="p">(</span><span class="n">btn3</span><span class="p">,</span> <span class="n">LV_BTN_PART_MAIN</span><span class="p">,</span> <span class="n">LV_STATE_DEFAULT</span><span class="p">,</span> <span class="s">&quot;Ripple&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="cp">#endif</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="micropython">
<h3>MicroPython<a class="headerlink" href="#micropython" title="Permalink to this headline">¶</a></h3>
<div class="section" id="id1">
<h4>Simple Buttons<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
Click to try in the simulator!<br/><a target='_blank' href='https://sim.lvgl.io/v7/micropython/ports/javascript/bundle_out/index.html?script_startup=https://raw.githubusercontent.com/lvgl/lv_demos/release/v7/src/header.py&script=https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_btn_1/lv_ex_btn_1.py'><img alt='lv_ex_btn_1' src='https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_btn_1/lv_ex_btn_1.png'/></a><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">event_handler</span><span class="p">(</span><span class="n">source</span><span class="p">,</span><span class="n">evt</span><span class="p">):</span>
    <span class="k">if</span> <span class="n">evt</span> <span class="o">==</span> <span class="n">lv</span><span class="o">.</span><span class="n">EVENT</span><span class="o">.</span><span class="n">CLICKED</span><span class="p">:</span>
        <span class="k">if</span> <span class="n">source</span> <span class="o">==</span> <span class="n">btn1</span><span class="p">:</span>
            <span class="c1"># treat &quot;clicked&quot; events only for btn1</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Clicked&quot;</span><span class="p">)</span>
        <span class="k">elif</span> <span class="n">evt</span> <span class="o">==</span> <span class="n">lv</span><span class="o">.</span><span class="n">EVENT</span><span class="o">.</span><span class="n">VALUE_CHANGED</span><span class="p">:</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Toggled&quot;</span><span class="p">)</span>


<span class="c1"># create a simple button</span>
<span class="n">btn1</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span><span class="kc">None</span><span class="p">)</span>
<span class="c1"># attach the callback</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">set_event_cb</span><span class="p">(</span><span class="n">event_handler</span><span class="p">)</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span><span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="o">-</span><span class="mi">40</span><span class="p">)</span>
<span class="n">label</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span><span class="kc">None</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">&quot;Button&quot;</span><span class="p">)</span>

<span class="c1"># create a toggle button</span>
<span class="n">btn2</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span><span class="kc">None</span><span class="p">)</span>
<span class="c1"># attach the callback</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_event_cb</span><span class="p">(</span><span class="n">event_handler</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span><span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">40</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_checkable</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">toggle</span><span class="p">()</span>
<span class="c1">#btn2.set_fit2(lv.FIT.NONE,lv.FIT.TIGHT)</span>
<span class="n">label</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span><span class="kc">None</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">&quot;Toggled&quot;</span><span class="p">)</span>

</pre></div>
</div>
</div>
Click to try in the simulator!<br/><a target='_blank' href='https://sim.lvgl.io/v7/micropython/ports/javascript/bundle_out/index.html?script_startup=https://raw.githubusercontent.com/lvgl/lv_demos/release/v7/src/header.py&script=https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_btn_2/lv_ex_btn_2.py'><img alt='lv_ex_btn_2' src='https://raw.githubusercontent.com/lvgl/lv_examples/9ebc61df6b7be07bd2fb4257fec49bf0dd178e2d/lv_ex_btn_2/lv_ex_btn_2.png'/></a><div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">path_overshoot</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="p">()</span>
<span class="n">path_overshoot</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">path_overshoot</span><span class="o">.</span><span class="n">set_cb</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="o">.</span><span class="n">overshoot</span><span class="p">)</span>

<span class="n">path_ease_out</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="p">()</span>
<span class="n">path_ease_out</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">path_overshoot</span><span class="o">.</span><span class="n">set_cb</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="o">.</span><span class="n">ease_out</span><span class="p">)</span>

<span class="n">path_ease_in_out</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="p">()</span>
<span class="n">path_ease_in_out</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">path_overshoot</span><span class="o">.</span><span class="n">set_cb</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">anim_path_t</span><span class="o">.</span><span class="n">ease_in_out</span><span class="p">)</span>

<span class="c1"># Gum line button    </span>
<span class="n">style_gum</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">style_t</span><span class="p">()</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transform_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transform_height</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="o">-</span><span class="mi">10</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_value_letter_space</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_path</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span><span class="n">path_overshoot</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_path</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span><span class="n">path_ease_in_out</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_time</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">250</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_delay</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_prop_1</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">TRANSFORM_WIDTH</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_prop_2</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">TRANSFORM_HEIGHT</span><span class="p">)</span>
<span class="n">style_gum</span><span class="o">.</span><span class="n">set_transition_prop_3</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">VALUE_LETTER_SPACE</span><span class="p">)</span>

<span class="n">btn1</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span><span class="kc">None</span><span class="p">)</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span><span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="o">-</span><span class="mi">80</span><span class="p">)</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">add_style</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span><span class="n">style_gum</span><span class="p">)</span>
<span class="c1"># Instead of creating a label add a values string*</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">set_style_local_value_str</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="s2">&quot;Gum&quot;</span><span class="p">);</span>

<span class="c1"># Halo on press</span>
<span class="n">style_halo</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">style_t</span><span class="p">()</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_transition_time</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">400</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_transition_time</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_transition_delay</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">200</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_outline_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_outline_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_outline_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">COVER</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_outline_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">FOCUSED</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">COVER</span><span class="p">)</span>   <span class="c1"># Just to be sure, the theme might use it</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_outline_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">TRANSP</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_transition_prop_1</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">OUTLINE_OPA</span><span class="p">)</span>
<span class="n">style_halo</span><span class="o">.</span><span class="n">set_transition_prop_2</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">OUTLINE_WIDTH</span><span class="p">)</span>

<span class="n">btn2</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span> <span class="kc">None</span><span class="p">);</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">add_style</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">style_halo</span><span class="p">);</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_style_local_value_str</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="s2">&quot;Halo&quot;</span><span class="p">);</span>

<span class="c1"># Ripple on press</span>
<span class="n">style_ripple</span><span class="o">=</span><span class="n">lv</span><span class="o">.</span><span class="n">style_t</span><span class="p">()</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_time</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">300</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_time</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_delay</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">300</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_bg_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_bg_opa</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">OPA</span><span class="o">.</span><span class="n">_80</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_border_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_outline_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transform_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="o">-</span><span class="mi">20</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transform_height</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="o">-</span><span class="mi">20</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transform_width</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transform_height</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">PRESSED</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>

<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_path</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">path_ease_out</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_prop_1</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">BG_OPA</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_prop_2</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">TRANSFORM_WIDTH</span><span class="p">)</span>
<span class="n">style_ripple</span><span class="o">.</span><span class="n">set_transition_prop_3</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STYLE</span><span class="o">.</span><span class="n">TRANSFORM_HEIGHT</span><span class="p">)</span>

<span class="n">btn3</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">btn3</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>
<span class="n">btn3</span><span class="o">.</span><span class="n">add_style</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">style_ripple</span><span class="p">)</span>
<span class="n">btn3</span><span class="o">.</span><span class="n">set_style_local_value_str</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="o">.</span><span class="n">PART</span><span class="o">.</span><span class="n">MAIN</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">STATE</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="s2">&quot;Ripple&quot;</span><span class="p">)</span>

</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt id="_CPPv414lv_btn_state_t">
<span id="_CPPv314lv_btn_state_t"></span><span id="_CPPv214lv_btn_state_t"></span><span id="lv_btn_state_t"></span><span class="target" id="lv__btn_8h_1ad76298e1d7b3cb0e8491be29483c7e8d"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_btn_state_t</span></code><a class="headerlink" href="#_CPPv414lv_btn_state_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv413lv_btn_part_t">
<span id="_CPPv313lv_btn_part_t"></span><span id="_CPPv213lv_btn_part_t"></span><span id="lv_btn_part_t"></span><span class="target" id="lv__btn_8h_1a9ab0f72b8438be1b33197aadd59b0179"></span><em class="property"><span class="pre">typedef</span> </em><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">lv_btn_part_t</span></code><a class="headerlink" href="#_CPPv413lv_btn_part_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt id="_CPPv4Ut2_56">
<span id="_CPPv3Ut2_56"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01d"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_56" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Possible states of a button. It can be used not only by buttons but other button-like objects too </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5621LV_BTN_STATE_RELEASEDE">
<span id="_CPPv3NUt2_5621LV_BTN_STATE_RELEASEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01daea76827ad0e2471846a7e8c3f22ac889"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_RELEASED</span></code><a class="headerlink" href="#_CPPv4NUt2_5621LV_BTN_STATE_RELEASEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5620LV_BTN_STATE_PRESSEDE">
<span id="_CPPv3NUt2_5620LV_BTN_STATE_PRESSEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01da32f15a03fb2526b18107544eb65c6102"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_PRESSED</span></code><a class="headerlink" href="#_CPPv4NUt2_5620LV_BTN_STATE_PRESSEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5621LV_BTN_STATE_DISABLEDE">
<span id="_CPPv3NUt2_5621LV_BTN_STATE_DISABLEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01da8db1c9fd525594ad32408af7868b5b7c"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_DISABLED</span></code><a class="headerlink" href="#_CPPv4NUt2_5621LV_BTN_STATE_DISABLEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5629LV_BTN_STATE_CHECKED_RELEASEDE">
<span id="_CPPv3NUt2_5629LV_BTN_STATE_CHECKED_RELEASEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01dab872031c4ef7fd2cd45cd681f649a6dc"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_CHECKED_RELEASED</span></code><a class="headerlink" href="#_CPPv4NUt2_5629LV_BTN_STATE_CHECKED_RELEASEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5628LV_BTN_STATE_CHECKED_PRESSEDE">
<span id="_CPPv3NUt2_5628LV_BTN_STATE_CHECKED_PRESSEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01dac6bd07dfb8d922ac4c14379676351c94"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_CHECKED_PRESSED</span></code><a class="headerlink" href="#_CPPv4NUt2_5628LV_BTN_STATE_CHECKED_PRESSEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5629LV_BTN_STATE_CHECKED_DISABLEDE">
<span id="_CPPv3NUt2_5629LV_BTN_STATE_CHECKED_DISABLEDE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01da523d083ba61ce19390fd51af401ef4d6"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_STATE_CHECKED_DISABLED</span></code><a class="headerlink" href="#_CPPv4NUt2_5629LV_BTN_STATE_CHECKED_DISABLEDE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5618_LV_BTN_STATE_LASTE">
<span id="_CPPv3NUt2_5618_LV_BTN_STATE_LASTE"></span><span class="target" id="lv__btn_8h_1ac9420823bfeba78fce625fc105e3b01da9f4194466a45b0c3c490b6f4aa6364ba"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">_LV_BTN_STATE_LAST</span></code><a class="headerlink" href="#_CPPv4NUt2_5618_LV_BTN_STATE_LASTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

<dl class="cpp enum">
<dt id="_CPPv4Ut2_57">
<span id="_CPPv3Ut2_57"></span><span class="target" id="lv__btn_8h_1afa9be5679ab03d785820f2474c5ccc6e"></span><em class="property"><span class="pre">enum</span> </em><strong><span class="pre">[anonymous]</span></strong><a class="headerlink" href="#_CPPv4Ut2_57" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Styles </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5716LV_BTN_PART_MAINE">
<span id="_CPPv3NUt2_5716LV_BTN_PART_MAINE"></span><span class="target" id="lv__btn_8h_1afa9be5679ab03d785820f2474c5ccc6eaa0f85460c7a56f30dc17d7d37863608f"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">LV_BTN_PART_MAIN</span></code><a class="headerlink" href="#_CPPv4NUt2_5716LV_BTN_PART_MAINE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5725_LV_BTN_PART_VIRTUAL_LASTE">
<span id="_CPPv3NUt2_5725_LV_BTN_PART_VIRTUAL_LASTE"></span><span class="target" id="lv__btn_8h_1afa9be5679ab03d785820f2474c5ccc6ea2e98f5f03d98891438fa82415c585904"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">_LV_BTN_PART_VIRTUAL_LAST</span></code><a class="headerlink" href="#_CPPv4NUt2_5725_LV_BTN_PART_VIRTUAL_LASTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_5722_LV_BTN_PART_REAL_LASTE">
<span id="_CPPv3NUt2_5722_LV_BTN_PART_REAL_LASTE"></span><span class="target" id="lv__btn_8h_1afa9be5679ab03d785820f2474c5ccc6ea1969919e8f14c03cd433e37992072c65"></span><em class="property"><span class="pre">enumerator</span> </em><code class="sig-name descname"><span class="pre">_LV_BTN_PART_REAL_LAST</span></code><a class="headerlink" href="#_CPPv4NUt2_5722_LV_BTN_PART_REAL_LASTE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt id="_CPPv413lv_btn_createP8lv_obj_tPK8lv_obj_t">
<span id="_CPPv313lv_btn_createP8lv_obj_tPK8lv_obj_t"></span><span id="_CPPv213lv_btn_createP8lv_obj_tPK8lv_obj_t"></span><span id="lv_btn_create__lv_obj_tP.lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a9019f4e861e31cd369b433b9d2a2fc0c"></span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><code class="sig-name descname"><span class="pre">lv_btn_create</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">par</span></em>, <em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">copy</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413lv_btn_createP8lv_obj_tPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Create a button object </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>par</strong> -- pointer to an object, it will be the parent of the new button </p></li>
<li><p><strong>copy</strong> -- pointer to a button object, if not NULL then the new object will be copied from it </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>pointer to the created button </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv420lv_btn_set_checkableP8lv_obj_tb">
<span id="_CPPv320lv_btn_set_checkableP8lv_obj_tb"></span><span id="_CPPv220lv_btn_set_checkableP8lv_obj_tb"></span><span id="lv_btn_set_checkable__lv_obj_tP.b"></span><span class="target" id="lv__btn_8h_1a3905685456b3093bd272c1c034ba5b38"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_checkable</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <span class="pre">bool</span> <em><span class="pre">tgl</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420lv_btn_set_checkableP8lv_obj_tb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Enable the toggled states. On release the button will change from/to toggled state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>tgl</strong> -- true: enable toggled states, false: disable </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_set_stateP8lv_obj_t14lv_btn_state_t">
<span id="_CPPv316lv_btn_set_stateP8lv_obj_t14lv_btn_state_t"></span><span id="_CPPv216lv_btn_set_stateP8lv_obj_t14lv_btn_state_t"></span><span id="lv_btn_set_state__lv_obj_tP.lv_btn_state_t"></span><span class="target" id="lv__btn_8h_1ac9f0f3f344ff91e547491c93293ac591"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_state</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <a class="reference internal" href="#_CPPv414lv_btn_state_t" title="lv_btn_state_t"><span class="pre">lv_btn_state_t</span></a> <em><span class="pre">state</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_set_stateP8lv_obj_t14lv_btn_state_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the state of the button </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>state</strong> -- the new state of the button (from lv_btn_state_t enum) </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv413lv_btn_toggleP8lv_obj_t">
<span id="_CPPv313lv_btn_toggleP8lv_obj_t"></span><span id="_CPPv213lv_btn_toggleP8lv_obj_t"></span><span id="lv_btn_toggle__lv_obj_tP"></span><span class="target" id="lv__btn_8h_1a906c44ebe25f1d8a6edbb528b03b5c89"></span><span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_toggle</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413lv_btn_toggleP8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggle the state of the button (ON-&gt;OFF, OFF-&gt;ON) </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_set_layoutP8lv_obj_t11lv_layout_t">
<span id="_CPPv317lv_btn_set_layoutP8lv_obj_t11lv_layout_t"></span><span id="_CPPv217lv_btn_set_layoutP8lv_obj_t11lv_layout_t"></span><span id="lv_btn_set_layout__lv_obj_tP.lv_layout_t"></span><span class="target" id="lv__btn_8h_1af889fd9cc4cac8e4224321a106ba2f4d"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_layout</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <a class="reference internal" href="cont.html#_CPPv411lv_layout_t" title="lv_layout_t"><span class="pre">lv_layout_t</span></a> <em><span class="pre">layout</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_set_layoutP8lv_obj_t11lv_layout_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the layout on a button </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>layout</strong> -- a layout from 'lv_cont_layout_t' </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv415lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t">
<span id="_CPPv315lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t"></span><span id="_CPPv215lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t"></span><span id="lv_btn_set_fit4__lv_obj_tP.lv_fit_t.lv_fit_t.lv_fit_t.lv_fit_t"></span><span class="target" id="lv__btn_8h_1aec9f3495266585a143f283d7effa518a"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_fit4</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">left</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">right</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">top</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">bottom</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy in all 4 directions separately. It tells how to change the button size automatically. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>left</strong> -- left fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><strong>right</strong> -- right fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><strong>top</strong> -- top fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><strong>bottom</strong> -- bottom fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv415lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t">
<span id="_CPPv315lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t"></span><span id="_CPPv215lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t"></span><span id="lv_btn_set_fit2__lv_obj_tP.lv_fit_t.lv_fit_t"></span><span class="target" id="lv__btn_8h_1a6b49c65cd0fb916015f5cd5d41058f85"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_fit2</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">hor</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">ver</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy horizontally and vertically separately. It tells how to change the button size automatically. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>hor</strong> -- horizontal fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><strong>ver</strong> -- vertical fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv414lv_btn_set_fitP8lv_obj_t8lv_fit_t">
<span id="_CPPv314lv_btn_set_fitP8lv_obj_t8lv_fit_t"></span><span id="_CPPv214lv_btn_set_fitP8lv_obj_t8lv_fit_t"></span><span id="lv_btn_set_fit__lv_obj_tP.lv_fit_t"></span><span class="target" id="lv__btn_8h_1abd07e9312fad15bfff86cdbd741b19aa"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <span class="pre">void</span> <code class="sig-name descname"><span class="pre">lv_btn_set_fit</span></code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <em><span class="pre">fit</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414lv_btn_set_fitP8lv_obj_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy in all 4 direction at once. It tells how to change the button size automatically. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>btn</strong> -- pointer to a button object </p></li>
<li><p><strong>fit</strong> -- fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_get_statePK8lv_obj_t">
<span id="_CPPv316lv_btn_get_statePK8lv_obj_t"></span><span id="_CPPv216lv_btn_get_statePK8lv_obj_t"></span><span id="lv_btn_get_state__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1ab2649a6b5c41f95269f3d8c93d34f441"></span><a class="reference internal" href="#_CPPv414lv_btn_state_t" title="lv_btn_state_t"><span class="pre">lv_btn_state_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_state</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_get_statePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the current state of the button </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the state of the button (from lv_btn_state_t enum) If the button is in disabled state <code class="docutils literal notranslate"><span class="pre">LV_BTN_STATE_DISABLED</span></code> will be ORed to the other button states. </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv420lv_btn_get_checkablePK8lv_obj_t">
<span id="_CPPv320lv_btn_get_checkablePK8lv_obj_t"></span><span id="_CPPv220lv_btn_get_checkablePK8lv_obj_t"></span><span id="lv_btn_get_checkable__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a31242b57335f59483af57deee759817c"></span><span class="pre">bool</span> <code class="sig-name descname"><span class="pre">lv_btn_get_checkable</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420lv_btn_get_checkablePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the toggle enable attribute of the button </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>true: checkable enabled, false: disabled </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_get_layoutPK8lv_obj_t">
<span id="_CPPv317lv_btn_get_layoutPK8lv_obj_t"></span><span id="_CPPv217lv_btn_get_layoutPK8lv_obj_t"></span><span id="lv_btn_get_layout__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1ab701e50276c79f36e70b2447abea538a"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="cont.html#_CPPv411lv_layout_t" title="lv_layout_t"><span class="pre">lv_layout_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_layout</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_get_layoutPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the layout of a button </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the layout from 'lv_cont_layout_t' </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv419lv_btn_get_fit_leftPK8lv_obj_t">
<span id="_CPPv319lv_btn_get_fit_leftPK8lv_obj_t"></span><span id="_CPPv219lv_btn_get_fit_leftPK8lv_obj_t"></span><span id="lv_btn_get_fit_left__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1aa627cd830b4890739094bda7be31a864"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_fit_left</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419lv_btn_get_fit_leftPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the left fit mode </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv420lv_btn_get_fit_rightPK8lv_obj_t">
<span id="_CPPv320lv_btn_get_fit_rightPK8lv_obj_t"></span><span id="_CPPv220lv_btn_get_fit_rightPK8lv_obj_t"></span><span id="lv_btn_get_fit_right__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1acb8d00c53aed23fbba1c1e13095d8f71"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_fit_right</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420lv_btn_get_fit_rightPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the right fit mode </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv418lv_btn_get_fit_topPK8lv_obj_t">
<span id="_CPPv318lv_btn_get_fit_topPK8lv_obj_t"></span><span id="_CPPv218lv_btn_get_fit_topPK8lv_obj_t"></span><span id="lv_btn_get_fit_top__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a9dd5acae9cabe814c279c82c78b9e1eb"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_fit_top</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418lv_btn_get_fit_topPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the top fit mode </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
</dl>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv421lv_btn_get_fit_bottomPK8lv_obj_t">
<span id="_CPPv321lv_btn_get_fit_bottomPK8lv_obj_t"></span><span id="_CPPv221lv_btn_get_fit_bottomPK8lv_obj_t"></span><span id="lv_btn_get_fit_bottom__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a049ef6780b716f82d921974fe14227e9"></span><em class="property"><span class="pre">static</span></em> <em class="property"><span class="pre">inline</span></em> <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t"><span class="pre">lv_fit_t</span></a> <code class="sig-name descname"><span class="pre">lv_btn_get_fit_bottom</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">const</span></em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t"><span class="pre">lv_obj_t</span></a> <span class="pre">*</span><em><span class="pre">btn</span></em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421lv_btn_get_fit_bottomPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the bottom fit mode </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btn</strong> -- pointer to a button object </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
</dl>
</dd></dl>

</div>
<dl class="cpp struct">
<dt id="_CPPv412lv_btn_ext_t">
<span id="_CPPv312lv_btn_ext_t"></span><span id="_CPPv212lv_btn_ext_t"></span><span id="lv_btn_ext_t"></span><span class="target" id="structlv__btn__ext__t"></span><em class="property"><span class="pre">struct</span> </em><code class="sig-name descname"><span class="pre">lv_btn_ext_t</span></code><a class="headerlink" href="#_CPPv412lv_btn_ext_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><em>#include &lt;lv_btn.h&gt;</em><p>Extended data of button </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t4contE">
<span id="_CPPv3N12lv_btn_ext_t4contE"></span><span id="_CPPv2N12lv_btn_ext_t4contE"></span><span id="lv_btn_ext_t::cont__lv_cont_ext_t"></span><span class="target" id="structlv__btn__ext__t_1af1e27a69f6cadfc900f6ae47f2e8d33e"></span><a class="reference internal" href="cont.html#_CPPv413lv_cont_ext_t" title="lv_cont_ext_t"><span class="pre">lv_cont_ext_t</span></a> <code class="sig-name descname"><span class="pre">cont</span></code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t4contE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Ext. of ancestor </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t9checkableE">
<span id="_CPPv3N12lv_btn_ext_t9checkableE"></span><span id="_CPPv2N12lv_btn_ext_t9checkableE"></span><span id="lv_btn_ext_t::checkable__uint8_t"></span><span class="target" id="structlv__btn__ext__t_1a98bf65f86ca41b13f72aedb63ad6bb0b"></span><span class="pre">uint8_t</span> <code class="sig-name descname"><span class="pre">checkable</span></code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t9checkableE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>1: Toggle enabled </p>
</dd></dl>

</div>
</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="btnmatrix.html" class="btn btn-neutral float-right" title="Button matrix (lv_btnmatrix)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="bar.html" class="btn btn-neutral float-left" title="Bar (lv_bar)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        
        &copy; Copyright 2020, LVGL LLC
      <span class="lastupdated">
        Last updated on May 14, 2021.
      </span>

    </p>
  </div>
    
    
    
    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
  

 <script type="text/javascript">
    $(document).ready(function() {
        $(".toggle > *").hide();
        $(".toggle .header").show();
        $(".toggle .header").click(function() {
            $(this).parent().children().not(".header").toggle(400);
            $(this).parent().children(".header").toggleClass("open");
        })
    });
</script>

<script type="text/javascript">
function add_version_selector()
{
    return fetch("https://raw.githubusercontent.com/lvgl/docs_compiled/gh-pages/versionlist.txt")
        .then(res => res.text())
        .then(text => {
            const versions = text.split("\n").filter(version => version.trim().length > 0);
            p = document.getElementById("rtd-search-form").parentElement;
            p.innerHTML = `
            <select name="versions" id="versions" onchange="ver_sel()" style="border-radius:5px; margin-bottom:15px">
            ${versions.map(version => `<option value="${version}">${version}</option>`)}
            </select>` + p.innerHTML;
        });
}

function ver_sel()
{
  var x = document.getElementById("versions").value;
  window.location.href = window.location.protocol + "//" + window.location.host + "/" + x + "/";
}

document.addEventListener('DOMContentLoaded', (event) => {
    add_version_selector().then(() => {
        var value = window.location.pathname.split('/')[1];
        document.getElementById("versions").value = value;
    });
    
})
</script>


</body>
</html>